Entity Trap
Trap is the Entity definition for a trap.
Subclass of Collectable.
Functions
| GetOwner () | GetOwner returns the owner Entity for an active trap. |
| GetHolder () | GetHolder returns the current holder Entity for an active trap. |
| GetSkillRoll () | GetSkillRoll returns the skill roll value when the trap was placed. |
| IsActivated () | IsActivated returns true if the trap is active. |
| IsHidden () | IsHidden returns true if the trap is hidden. |
| GetDetonationTime () | GetDetonationTime returns the millisecond timer value for the trap to explode. |
| GetFrequency () | GetFrequency returns the frequency of the trap. |
| IsReusable () | IsReusable returns true if the trap is reusable. |
| GetDifficulty () | GetDifficulty returns the disarm difficulty of the trap. |
| GetCriticalChance () | GetCriticalChance returns the critical hit chance of the trap. |
| GetMinBaseDamage () | GetMinBaseDamage returns the minimum base damage of the trap. |
| GetMaxBaseDamage () | GetMaxBaseDamage returns the maximum base damage of the trap. |
| GetPrimaryDamageType () | GetPrimaryDamageType returns the primary type of damage for the trap. |
| GetSecondaryDamageType () | GetSecondaryDamageType returns the secondary effect for the trap, if any. |
| GetAmmoVariant () | GetAmmoVariant returns the ammo variant to use when calculating damage and penetration of the trap. |
| GetDamageRadius () | GetDamageRadius returns the blast radius of the trap. |
| GetImpactFX () | GetImpactFX returns the effect to use to show impact to a character. |
Functions
- GetOwner ()
-
GetOwner returns the owner Entity for an active trap.
Returns:
- GetHolder ()
-
GetHolder returns the current holder Entity for an active trap.
Returns:
-
An Entity indicating the trap holder.
- GetSkillRoll ()
-
GetSkillRoll returns the skill roll value when the trap was placed.
Returns:
-
An integer indicating the skill roll.
- IsActivated ()
-
IsActivated returns true if the trap is active.
Returns:
-
A boolean indicating if the trap is active.
- IsHidden ()
-
IsHidden returns true if the trap is hidden.
Returns:
-
A boolean indicating if the trap is hidden.
- GetDetonationTime ()
-
GetDetonationTime returns the millisecond timer value for the trap to explode.
Returns:
-
A large integer indicating the explosion time.
- GetFrequency ()
-
GetFrequency returns the frequency of the trap.
Returns:
-
A numeric value indicating the trap's frequency.
- IsReusable ()
-
IsReusable returns true if the trap is reusable.
Returns:
-
A boolean value indicating if the trap is reusable.
- GetDifficulty ()
-
GetDifficulty returns the disarm difficulty of the trap.
Returns:
-
An integer indicating the trap difficulty.
- GetCriticalChance ()
-
GetCriticalChance returns the critical hit chance of the trap.
Returns:
-
An integer indicating the trap critical hit chance.
- GetMinBaseDamage ()
-
GetMinBaseDamage returns the minimum base damage of the trap.
Returns:
-
An integer indicating the trap minimum damage.
- GetMaxBaseDamage ()
-
GetMaxBaseDamage returns the maximum base damage of the trap.
Returns:
-
An integer indicating the trap maximum damage.
- GetPrimaryDamageType ()
-
GetPrimaryDamageType returns the primary type of damage for the trap.
Returns:
-
A string indicating the trap primary damage type.
- GetSecondaryDamageType ()
-
GetSecondaryDamageType returns the secondary effect for the trap, if any.
Returns:
-
A string indicating the trap secondary effect type.
- GetAmmoVariant ()
-
GetAmmoVariant returns the ammo variant to use when calculating damage and penetration of the trap.
Returns:
-
A string indicating the trap ammo variant.
- GetDamageRadius ()
-
GetDamageRadius returns the blast radius of the trap.
Returns:
-
A numeric value indicating the trap radius.
- GetImpactFX ()
-
GetImpactFX returns the effect to use to show impact to a character.
Returns:
-
A string indicating the impact effect.